Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

82 feature request suggestion create GitHub actions workflow for automating the build and deployments for feature branches #87

Open
wants to merge 73 commits into
base: main
Choose a base branch
from

Conversation

lmcdonough
Copy link
Contributor

@lmcdonough lmcdonough commented Dec 13, 2024

This pull request introduces a new GitHub Actions workflow to build and deploy Docker containers for Rust and Next.js projects. The workflow includes steps for building, testing, and pushing Docker images to the GitHub Container Registry.

GitHub Issue: Closes #82

Changes

  • Added a new Github Actions workflow configuration file .github/workflows/build_and_deploy_containers.yml to automate the build and deployment process for feature branches and pull requests to the main branch.
  • Defined two main jobs: build_test_run for building and testing the project, and build_and_push_docker for building and pushing Docker images. The latter job depends on the successful completion of the former.
  • Configured steps to checkout the repository, install the Rust toolchain, use cached dependencies, install seaORM CLI, build the project, and run tests.
  • Configured steps to checkout the repository, log in to the GitHub Container Registry, set up Docker Buildx, cache Docker layers, and build and push Docker images for both the Rust backend and the Next.js frontend.
  • Implemented a caching mechanism for Docker layers to optimize the build process, including steps## Description

Testing Strategy

  • Manually use the workflow_dispatch to iterate and view any errors from the workflow run.

Concerns

  • Managing environment variables, and secrets can be improved upon in the future.

@lmcdonough lmcdonough self-assigned this Dec 13, 2024
@lmcdonough lmcdonough requested a review from jhodapp December 13, 2024 19:56
@lmcdonough lmcdonough added the feature work Specifically implementing a new feature label Dec 13, 2024
@lmcdonough lmcdonough force-pushed the 82-feature-request-suggestion-create-github-actions-workflow-for-automating-the-build-and-deployments-for-feature-branches branch from 2461703 to 13a682f Compare February 10, 2025 19:22
@jhodapp jhodapp added the infrastructure DevOps related label Feb 25, 2025
@lmcdonough lmcdonough force-pushed the 82-feature-request-suggestion-create-github-actions-workflow-for-automating-the-build-and-deployments-for-feature-branches branch 2 times, most recently from 2415efa to eb1d6b4 Compare April 4, 2025 01:06
… with updated actions, improved environment variable handling, and added artifact attestations for images.
…tructure

- Change base image in Dockerfile to rust:1.70-slim
- Use environment variable for backend port in Dockerfile
- Update volume paths in docker-compose to point to the docs directory
- Specify build target in docker-compose for runtime
- Adjust frontend build context in docker-compose
@lmcdonough lmcdonough force-pushed the 82-feature-request-suggestion-create-github-actions-workflow-for-automating-the-build-and-deployments-for-feature-branches branch from 6f5ba61 to 91bc521 Compare April 11, 2025 17:32
@lmcdonough lmcdonough requested a review from jhodapp April 11, 2025 18:32
@lmcdonough lmcdonough marked this pull request as ready for review April 11, 2025 18:35
@jhodapp jhodapp moved this from 🏗 In progress to Review in Refactor Coaching Platform Apr 11, 2025
@jhodapp jhodapp requested a review from calebbourg April 11, 2025 18:46
Copy link
Member

@jhodapp jhodapp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Levi, a couple more changes requested.

@lmcdonough lmcdonough requested a review from jhodapp April 12, 2025 19:39
adds badge for container build status to readme.
Comment on lines +56 to +59
TIPTAP_URL="https://ok01532m.collab.tiptap.cloud" # URL for the TipTap service
TIPTAP_AUTH_KEY="6122462e59d7cc8c6146f4e3b5c93dfad28c8a219838df69b59ffcec4cdc0041"
# Authentication key for TipTap
TIPTAP_JWT_SIGNING_KEY="0f38cb0650a8fc262258ad415f25c52579bfc4095b222f486557d24c8fafaeb8" # JWT signing key for TipTap
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lmcdonough Please remove these keys and the URL. You can use empty strings here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature work Specifically implementing a new feature infrastructure DevOps related
Projects
Status: Review
2 participants